\hypertarget{class_image_capture_d_v1394}{
\section{ImageCaptureDV1394 Class Reference}
\label{class_image_capture_d_v1394}\index{ImageCaptureDV1394@{ImageCaptureDV1394}}
}


\hyperlink{class_video}{Video} Capture interface that uses fw1394 to acquire video from capture cards and other devices in Linux.  


{\ttfamily \#include $<$imagecapturedv1394.h$>$}\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\hyperlink{class_image_capture_d_v1394_a2e58fb36157f65580a34efc34614f49c}{ImageCaptureDV1394} ()
\begin{DoxyCompactList}\small\item\em Constructor. \item\end{DoxyCompactList}\item 
\hypertarget{class_image_capture_d_v1394_ab68d194056d15143a863c60cfbbe6246}{
\hyperlink{class_image_capture_d_v1394_ab68d194056d15143a863c60cfbbe6246}{$\sim$ImageCaptureDV1394} ()}
\label{class_image_capture_d_v1394_ab68d194056d15143a863c60cfbbe6246}

\begin{DoxyCompactList}\small\item\em Destructor. \item\end{DoxyCompactList}\item 
int \hyperlink{class_image_capture_d_v1394_adf66017e645fc4a48013cf868471c0b8}{Start} (const std::string \&videoSource, const int width=0, const int height=0, const bool interlace=false)
\begin{DoxyCompactList}\small\item\em Use this method to start capture from a video source. \item\end{DoxyCompactList}\item 
int \hyperlink{class_image_capture_d_v1394_a2c590d3d3e1bc7db926ba35d8a9608c6}{Stop} ()
\begin{DoxyCompactList}\small\item\em Stops video capture. \item\end{DoxyCompactList}\item 
int \hyperlink{class_image_capture_d_v1394_aaded8de87c7a83d0eec0bdb4f5a76b90}{GetFrame} (\hyperlink{class_cv_image_capture_1_1_image}{CvImageCapture::Image} $\ast$dest, const bool block=false)
\begin{DoxyCompactList}\small\item\em Use this method to get the current frame from the camera/video source. \item\end{DoxyCompactList}\item 
bool \hyperlink{class_image_capture_d_v1394_a4e1f1c5673f883de10e118a7cd2587d1}{IsReady} () const 
\end{DoxyCompactItemize}
\subsection*{Static Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\hypertarget{class_image_capture_d_v1394_a5a08aab96e05c8b70faa9af2ad85b9bb}{
static unsigned int {\bfseries ScanForSources} (std::vector$<$ std::string $>$ \&sources)}
\label{class_image_capture_d_v1394_a5a08aab96e05c8b70faa9af2ad85b9bb}

\end{DoxyCompactItemize}


\subsection{Detailed Description}
\hyperlink{class_video}{Video} Capture interface that uses fw1394 to acquire video from capture cards and other devices in Linux. Filename: \hyperlink{imagecapturedc1394_8h_source}{imagecapturedc1394.h}

Copyright 2009 Gary Stein Daniel Barber David Adams Robotics Laboratory University of Central Florida \href{http://robotics.ucf.edu}{\tt http://robotics.ucf.edu}

Program Contents: -\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/ Contains a wrapper class for the libv4l image capture library. -\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. Neither the name of the Robotics Club at UCF, UCF, nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE ROBOTICS CLUB AT UCF ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL UCF BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Required Libraries: Windows: Not supported. Linux: fw1394 

\subsection{Constructor \& Destructor Documentation}
\hypertarget{class_image_capture_d_v1394_a2e58fb36157f65580a34efc34614f49c}{
\index{ImageCaptureDV1394@{ImageCaptureDV1394}!ImageCaptureDV1394@{ImageCaptureDV1394}}
\index{ImageCaptureDV1394@{ImageCaptureDV1394}!ImageCaptureDV1394@{ImageCaptureDV1394}}
\subsubsection[{ImageCaptureDV1394}]{\setlength{\rightskip}{0pt plus 5cm}ImageCaptureDV1394::ImageCaptureDV1394 ()}}
\label{class_image_capture_d_v1394_a2e58fb36157f65580a34efc34614f49c}


Constructor. Filename: imagecapturedv1394.cpp

Copyright 2009 Gary Stein Daniel Barber David Adams Robotics Laboratory University of Central Florida \href{http://robotics.ucf.edu}{\tt http://robotics.ucf.edu}

Program Contents: -\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/ Contains a wrapper class for the libv4l image capture library. -\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/-\/

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. Neither the name of the Robotics Club at UCF, UCF, nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE ROBOTICS CLUB AT UCF ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL UCF BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 

\subsection{Member Function Documentation}
\hypertarget{class_image_capture_d_v1394_aaded8de87c7a83d0eec0bdb4f5a76b90}{
\index{ImageCaptureDV1394@{ImageCaptureDV1394}!GetFrame@{GetFrame}}
\index{GetFrame@{GetFrame}!ImageCaptureDV1394@{ImageCaptureDV1394}}
\subsubsection[{GetFrame}]{\setlength{\rightskip}{0pt plus 5cm}int ImageCaptureDV1394::GetFrame ({\bf CvImageCapture::Image} $\ast$ {\em dest}, \/  const bool {\em block} = {\ttfamily false})}}
\label{class_image_capture_d_v1394_aaded8de87c7a83d0eec0bdb4f5a76b90}


Use this method to get the current frame from the camera/video source. 
\begin{DoxyParams}{Parameters}
\item[\mbox{$\rightarrow$} {\em Pointer}]to image structure to fill with current frame. \item[\mbox{$\leftarrow$} {\em block}]If true, this method will block until a new frame arrives otherwise it will fall through if a new frame isn't available.\end{DoxyParams}
\begin{DoxyReturn}{Returns}
1 on success, 0 on failure. 
\end{DoxyReturn}
\hypertarget{class_image_capture_d_v1394_a4e1f1c5673f883de10e118a7cd2587d1}{
\index{ImageCaptureDV1394@{ImageCaptureDV1394}!IsReady@{IsReady}}
\index{IsReady@{IsReady}!ImageCaptureDV1394@{ImageCaptureDV1394}}
\subsubsection[{IsReady}]{\setlength{\rightskip}{0pt plus 5cm}bool ImageCaptureDV1394::IsReady () const}}
\label{class_image_capture_d_v1394_a4e1f1c5673f883de10e118a7cd2587d1}
\begin{DoxyReturn}{Returns}
True if ready to capture image data, false otherwise. 
\end{DoxyReturn}
\hypertarget{class_image_capture_d_v1394_adf66017e645fc4a48013cf868471c0b8}{
\index{ImageCaptureDV1394@{ImageCaptureDV1394}!Start@{Start}}
\index{Start@{Start}!ImageCaptureDV1394@{ImageCaptureDV1394}}
\subsubsection[{Start}]{\setlength{\rightskip}{0pt plus 5cm}int ImageCaptureDV1394::Start (const std::string \& {\em videoSource}, \/  const int {\em width} = {\ttfamily 0}, \/  const int {\em height} = {\ttfamily 0}, \/  const bool {\em interlace} = {\ttfamily false})}}
\label{class_image_capture_d_v1394_adf66017e645fc4a48013cf868471c0b8}


Use this method to start capture from a video source. 
\begin{DoxyParams}{Parameters}
\item[\mbox{$\leftarrow$} {\em videoSource}]Camera/Video source name or file path. Examples: \char`\"{}/dev/video0\char`\"{} or \char`\"{}Logitech Pro 9000\char`\"{}. \item[\mbox{$\leftarrow$} {\em width}]Desired image capture width. If set to 0, then the default settings for the camera are used (default value). \item[\mbox{$\leftarrow$} {\em height}]Desired image capture height. If set to 0 then the default settings for the camera are used (default value). \item[\mbox{$\leftarrow$} {\em interlace}]If the image data is interlaced, this flag will enable automatic de-\/interlacing.\end{DoxyParams}
\begin{DoxyReturn}{Returns}
1 on success, 0 on failure. 
\end{DoxyReturn}
\hypertarget{class_image_capture_d_v1394_a2c590d3d3e1bc7db926ba35d8a9608c6}{
\index{ImageCaptureDV1394@{ImageCaptureDV1394}!Stop@{Stop}}
\index{Stop@{Stop}!ImageCaptureDV1394@{ImageCaptureDV1394}}
\subsubsection[{Stop}]{\setlength{\rightskip}{0pt plus 5cm}int ImageCaptureDV1394::Stop ()}}
\label{class_image_capture_d_v1394_a2c590d3d3e1bc7db926ba35d8a9608c6}


Stops video capture. \begin{DoxyReturn}{Returns}
1 on succes, 0 on failure. 
\end{DoxyReturn}


The documentation for this class was generated from the following files:\begin{DoxyCompactItemize}
\item 
C:/Users/Matt/Documents/School/Robotics/zebulon/v2/cv/include/cv/imagecapturedv1394.h\item 
C:/Users/Matt/Documents/School/Robotics/zebulon/v2/cv/src/cv/imagecapturedv1394.cpp\end{DoxyCompactItemize}
